<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.15"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>QuantumLibrary: Bloomberg::quantum::FutureException Struct Reference</title>
<link href="../../tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="../../jquery.js"></script>
<script type="text/javascript" src="../../dynsections.js"></script>
<link href="../../navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="../../resize.js"></script>
<script type="text/javascript" src="../../navtreedata.js"></script>
<script type="text/javascript" src="../../navtree.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
  $(document).ready(initResizable);
/* @license-end */</script>
<link href="../../search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="../../search/searchdata.js"></script>
<script type="text/javascript" src="../../search/search.js"></script>
<link href="../../doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr style="height: 56px;">
  <td id="projectalign" style="padding-left: 0.5em;">
   <div id="projectname">QuantumLibrary
   </div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.15 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
var searchBox = new SearchBox("searchBox", "../../search",false,'Search');
/* @license-end */
</script>
<script type="text/javascript" src="../../menudata.js"></script>
<script type="text/javascript" src="../../menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
$(function() {
  initMenu('../../',true,false,'search.php','Search');
  $(document).ready(function() { init_search(); });
});
/* @license-end */</script>
<div id="main-nav"></div>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
  <div id="nav-tree">
    <div id="nav-tree-contents">
      <div id="nav-sync" class="sync"></div>
    </div>
  </div>
  <div id="splitbar" style="-moz-user-select:none;" 
       class="ui-resizable-handle">
  </div>
</div>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
$(document).ready(function(){initNavTree('d2/d14/structBloomberg_1_1quantum_1_1FutureException.html','../../');});
/* @license-end */
</script>
<div id="doc-content">
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
     onmouseover="return searchBox.OnSearchSelectShow()"
     onmouseout="return searchBox.OnSearchSelectHide()"
     onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>

<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0" 
        name="MSearchResults" id="MSearchResults">
</iframe>
</div>

<div class="header">
  <div class="summary">
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="../../dc/d40/structBloomberg_1_1quantum_1_1FutureException-members.html">List of all members</a>  </div>
  <div class="headertitle">
<div class="title">Bloomberg::quantum::FutureException Struct Reference</div>  </div>
</div><!--header-->
<div class="contents">

<p>Exception thrown by a <a class="el" href="../../dc/d14/classBloomberg_1_1quantum_1_1Future.html" title="Class representing a promised future. Can only be instantiated via a Promise object.">Future</a> or <a class="el" href="../../d1/d15/classBloomberg_1_1quantum_1_1Promise.html" title="Class representing a promised value.">Promise</a> object during various errors.  
 <a href="../../d2/d14/structBloomberg_1_1quantum_1_1FutureException.html#details">More...</a></p>

<p><code>#include &lt;<a class="el" href="../../d0/db6/quantum__future__state_8h_source.html">quantum_future_state.h</a>&gt;</code></p>
<div class="dynheader">
Inheritance diagram for Bloomberg::quantum::FutureException:</div>
<div class="dyncontent">
 <div class="center">
  <img src="../../d2/d14/structBloomberg_1_1quantum_1_1FutureException.png" usemap="#Bloomberg::quantum::FutureException_map" alt=""/>
  <map id="Bloomberg::quantum::FutureException_map" name="Bloomberg::quantum::FutureException_map">
<area href="../../d1/d0d/structBloomberg_1_1quantum_1_1BrokenPromiseException.html" alt="Bloomberg::quantum::BrokenPromiseException" shape="rect" coords="0,112,323,136"/>
<area href="../../d2/dfa/structBloomberg_1_1quantum_1_1BufferClosedException.html" alt="Bloomberg::quantum::BufferClosedException" shape="rect" coords="333,112,656,136"/>
<area href="../../d8/dde/structBloomberg_1_1quantum_1_1BufferingDataException.html" alt="Bloomberg::quantum::BufferingDataException" shape="rect" coords="666,112,989,136"/>
<area href="../../df/de1/structBloomberg_1_1quantum_1_1FutureAlreadyRetrievedException.html" alt="Bloomberg::quantum::FutureAlreadyRetrievedException" shape="rect" coords="999,112,1322,136"/>
<area href="../../d8/d11/structBloomberg_1_1quantum_1_1NoStateException.html" alt="Bloomberg::quantum::NoStateException" shape="rect" coords="1332,112,1655,136"/>
<area href="../../d4/df4/structBloomberg_1_1quantum_1_1PromiseAlreadySatisfiedException.html" alt="Bloomberg::quantum::PromiseAlreadySatisfiedException" shape="rect" coords="1665,112,1988,136"/>
<area href="../../d1/dc1/structBloomberg_1_1quantum_1_1PromiseNotSatisfiedException.html" alt="Bloomberg::quantum::PromiseNotSatisfiedException" shape="rect" coords="1998,112,2321,136"/>
  </map>
</div></div>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:a7bd88229a8dfa9690a5cd6bcab2778c7"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../d2/d14/structBloomberg_1_1quantum_1_1FutureException.html#a7bd88229a8dfa9690a5cd6bcab2778c7">FutureException</a> (<a class="el" href="../../dc/d48/namespaceBloomberg_1_1quantum.html#aae5974140a54463c3c55040f00e6f70b">FutureState</a> error)</td></tr>
<tr class="memdesc:a7bd88229a8dfa9690a5cd6bcab2778c7"><td class="mdescLeft">&#160;</td><td class="mdescRight">Constructor.  <a href="#a7bd88229a8dfa9690a5cd6bcab2778c7">More...</a><br /></td></tr>
<tr class="separator:a7bd88229a8dfa9690a5cd6bcab2778c7"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:afff502e7d84df34e0b8c80b19298ad7f"><td class="memItemLeft" align="right" valign="top">const char *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../d2/d14/structBloomberg_1_1quantum_1_1FutureException.html#afff502e7d84df34e0b8c80b19298ad7f">what</a> () const noexcept override</td></tr>
<tr class="memdesc:afff502e7d84df34e0b8c80b19298ad7f"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get the encapsulated error message from the exception object.  <a href="#afff502e7d84df34e0b8c80b19298ad7f">More...</a><br /></td></tr>
<tr class="separator:afff502e7d84df34e0b8c80b19298ad7f"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>Exception thrown by a <a class="el" href="../../dc/d14/classBloomberg_1_1quantum_1_1Future.html" title="Class representing a promised future. Can only be instantiated via a Promise object.">Future</a> or <a class="el" href="../../d1/d15/classBloomberg_1_1quantum_1_1Promise.html" title="Class representing a promised value.">Promise</a> object during various errors. </p>
</div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
<a id="a7bd88229a8dfa9690a5cd6bcab2778c7"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a7bd88229a8dfa9690a5cd6bcab2778c7">&#9670;&nbsp;</a></span>FutureException()</h2>

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">Bloomberg::quantum::FutureException::FutureException </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="../../dc/d48/namespaceBloomberg_1_1quantum.html#aae5974140a54463c3c55040f00e6f70b">FutureState</a>&#160;</td>
          <td class="paramname"><em>error</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>Constructor. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramdir">[in]</td><td class="paramname">error</td><td>Enum representing the error state. </td></tr>
  </table>
  </dd>
</dl>

</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a id="afff502e7d84df34e0b8c80b19298ad7f"></a>
<h2 class="memtitle"><span class="permalink"><a href="#afff502e7d84df34e0b8c80b19298ad7f">&#9670;&nbsp;</a></span>what()</h2>

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">const char* Bloomberg::quantum::FutureException::what </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td> const</td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">override</span><span class="mlabel">noexcept</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>Get the encapsulated error message from the exception object. </p>
<dl class="section return"><dt>Returns</dt><dd>Error message. </dd></dl>

</div>
</div>
</div><!-- contents -->
</div><!-- doc-content -->
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
  <ul>
    <li class="navelem"><a class="el" href="../../d6/db9/namespaceBloomberg.html">Bloomberg</a></li><li class="navelem"><a class="el" href="../../dc/d48/namespaceBloomberg_1_1quantum.html">quantum</a></li><li class="navelem"><a class="el" href="../../d2/d14/structBloomberg_1_1quantum_1_1FutureException.html">FutureException</a></li>
    <li class="footer">Generated by
    <a href="http://www.doxygen.org/index.html">
    <img class="footer" src="../../doxygen.png" alt="doxygen"/></a> 1.8.15 </li>
  </ul>
</div>
</body>
</html>
